package org.dromara.common.satoken.core.dao;

import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.util.SaFoxUtil;
import com.github.benmanes.caffeine.cache.Cache;
import com.github.benmanes.caffeine.cache.Caffeine;
import org.dromara.common.redis.utils.RedisUtils;

import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.TimeUnit;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：Sa-Token持久层接口(使用框架自带RedisUtils实现 协议统一)
 * <p>
 * 采用 caffeine + redis 多级缓存 优化并发查询效率
 */
/**
 * 实现自定义SaTokenDao的类
 * 该类用于操作和管理token数据，支持自定义的数据访问操作
 */
public class PlusSaTokenDao implements SaTokenDao {

    // 创建并初始化一个基于Caffeine的缓存对象
    private static final Cache<String, Object> CAFFEINE = Caffeine.newBuilder()
        // 设置最后一次写入或访问后经过固定时间过期
        .expireAfterWrite(5, TimeUnit.SECONDS)
        // 初始的缓存空间大小
        .initialCapacity(100)
        // 缓存的最大条数
        .maximumSize(1000)
        .build();

    /**
     * 获取Value，如无返空
     * 根据指定的键获取缓存中的值
     * 此方法使用CAFFEINE缓存管理器来检索与给定键相关联的缓存对象如果缓存中没有该键的对象，
     * 则会通过RedisUtils从Redis中获取缓存对象，并将其存储在缓存中以供后续请求使用
     *
     * @param key 要从缓存中检索的项的键
     * @return 与键相关联的缓存值，如果没有找到则返回null
     */
    @Override
    public String get(String key) {
        Object o = CAFFEINE.get(key, k -> RedisUtils.getCacheObject(key));
        return (String) o;
    }

    /**
     * 写入Value，并设定存活时间 (单位: 秒)
     * 设置缓存值，并指定缓存的过期时间
     *
     * @param key 缓存的键
     * @param value 缓存的值
     * @param timeout 缓存的过期时间，单位为秒如果为0或小于等于NOT_VALUE_EXPIRE，则表示缓存永不过期
     */
    @Override
    public void set(String key, String value, long timeout) {
        // 检查过期时间是否为0或NOT_VALUE_EXPIRE，如果是，则不进行任何操作，直接返回
        if (timeout == 0 || timeout <= NOT_VALUE_EXPIRE) {
            return;
        }
        // 判断是否为永不过期
        if (timeout == NEVER_EXPIRE) {
            // 如果timeout为NEVER_EXPIRE，表示永不过期，直接设置缓存值
            RedisUtils.setCacheObject(key, value);
        } else {
            // 如果timeout有指定的具体过期时间，使用Duration.ofSeconds(timeout)表示过期时间，并设置缓存值
            RedisUtils.setCacheObject(key, value, Duration.ofSeconds(timeout));
        }
        // 无论哪种情况，都清除CAFFEINE中的缓存，确保一致性
        CAFFEINE.invalidate(key);
    }

    /**
     * 修修改指定key-value键值对 (过期时间不变)
     * 更新缓存中的项
     * 如果键存在于Redis中，则更新缓存对象，并从Caffeine缓存中移除对应的键
     *
     * @param key 需要更新的缓存项的键
     * @param value 需要更新的缓存项的新值
     */
    @Override
    public void update(String key, String value) {
        // 检查Redis中是否存在该键
        if (RedisUtils.hasKey(key)) {
            // 如果存在，更新Redis缓存对象的值
            RedisUtils.setCacheObject(key, value, true);
            // 从Caffeine缓存中移除对应的键，确保一致性
            CAFFEINE.invalidate(key);
        }
    }

    /**
     * 删除Value
     *
     * @param key 要删除的对象的键
     */
    @Override
    public void delete(String key) {
        RedisUtils.deleteObject(key);
    }

    /**
     * 获取Value的剩余存活时间 (单位: 秒)
     * 获取指定键的超时时间
     *
     * 此方法通过查询Redis数据库中键的剩余生存时间（TTL）来获取其超时时间如果键不存在或者没有设置过期时间，
     * 返回值将为负数使用此方法可以在运行时动态调整缓存策略，例如，决定是否从数据库重新加载数据
     *
     * @param key 要查询的Redis键
     * @return 键的超时时间，以秒为单位如果返回负数，则表示键不存在或没有设置过期时间
     */
    @Override
    public long getTimeout(String key) {
        // 获取键的剩余生存时间（以毫秒为单位）
        long timeout = RedisUtils.getTimeToLive(key);
        // 如果超时时间小于0，直接返回；否则将其转换为秒
        return timeout < 0 ? timeout : timeout / 1000;
    }

    /**
     * 修改Value的剩余存活时间 (单位: 秒)
     * 更新指定key的超时时间
     *
     * @param key 要更新超时时间的Redis键
     * @param timeout 新的超时时间，单位为秒
     */
    @Override
    public void updateTimeout(String key, long timeout) {
        // 使用RedisUtils设置键的过期时间
        RedisUtils.expire(key, Duration.ofSeconds(timeout));
    }


    /**
     * 获取Object，如无返空
     * 根据指定的键获取对象
     *
     * @param key 键，用于标识缓存中的对象
     * @return 缓存中的对象，如果找不到则返回null
     */
    @Override
    public Object getObject(String key) {
        // 使用CAFFEINE缓存管理器根据键获取对象，如果缓存中没有，则通过RedisUtils从Redis中获取
        Object o = CAFFEINE.get(key, k -> RedisUtils.getCacheObject(key));
        return o;
    }

    /**
     * 写入Object，并设定存活时间 (单位: 秒)
     * 设置对象到缓存中，并指定缓存过期时间
     *
     * @param key 缓存的键
     * @param object 要缓存的对象
     * @param timeout 缓存的过期时间，单位为秒如果为0或小于等于NOT_VALUE_EXPIRE，则表示不设置过期时间
     */
    @Override
    public void setObject(String key, Object object, long timeout) {
        // 检查过期时间是否为0或小于等于NOT_VALUE_EXPIRE，如果是，则不进行任何操作
        if (timeout == 0 || timeout <= NOT_VALUE_EXPIRE) {
            return;
        }
        // 判断是否为永不过期
        if (timeout == NEVER_EXPIRE) {
            // 如果过期时间为永不过期，直接将对象设置到Redis中，不设置过期时间
            RedisUtils.setCacheObject(key, object);
        } else {
            // 如果过期时间指定为特定秒数，将对象和过期时间设置到Redis中
            RedisUtils.setCacheObject(key, object, Duration.ofSeconds(timeout));
        }
        // 使Caffeine缓存失效，确保数据的一致性
        CAFFEINE.invalidate(key);
    }

    /**
     * 更新Object (过期时间不变)
     * 更新缓存中的对象如果存在的话
     * 当提供的键在Redis中存在时，这个方法用来更新缓存中的对象它首先尝试在Redis中设置新的对象，
     * 如果成功，它接着会在二级缓存中使该键失效，确保一致性
     *
     * @param key 要更新的缓存项的键
     * @param object 要更新到缓存中的新对象
     */
    @Override
    public void updateObject(String key, Object object) {
        // 检查Redis中是否存在指定的键
        if (RedisUtils.hasKey(key)) {
            // 如果存在，更新Redis缓存中的对象，并设置缓存策略为true，表示这是一个经过验证的操作
            RedisUtils.setCacheObject(key, object, true);
            // 使二级缓存中的对应键失效，确保下次访问时从Redis中加载最新数据
            CAFFEINE.invalidate(key);
        }
    }

    /**
     * 删除Object
     *
     * @param key 键，
     */
    @Override
    public void deleteObject(String key) {
        RedisUtils.deleteObject(key);
    }

    /**
     * 获取Object的剩余存活时间 (单位: 秒)
     * 获取对象的超时时间
     *
     * 此方法覆盖了接口中的同名方法，用于获取指定键在Redis中的超时时间
     * 它首先使用RedisUtils工具类获取键的剩余生存时间（TTL），然后根据返回的TTL值进行处理
     * 如果TTL小于0，表示键不存在或者永久有效，直接返回该值
     * 如果TTL大于等于0，表示键有一个正的超时时间，将其转换为秒后返回
     *
     * @param key 键，用于指定要获取超时时间的对象
     * @return 返回对象的超时时间，如果键不存在或永久有效，则返回负值
     */
    @Override
    public long getObjectTimeout(String key) {
        long timeout = RedisUtils.getTimeToLive(key);
        return timeout < 0 ? timeout : timeout / 1000;
    }

    /**
     * 修改Object的剩余存活时间 (单位: 秒)
     * 更新指定对象的超时时间
     *
     * @param key 键值，用于标识要更新的对象
     * @param timeout 新的超时时间，单位为秒
     *
     * 使用RedisUtils设置新超时时间，以提高缓存管理的效率和准确性
     */
    @Override
    public void updateObjectTimeout(String key, long timeout) {
        RedisUtils.expire(key, Duration.ofSeconds(timeout));
    }


    /**
     * 搜索数据
     * 根据前缀和关键字搜索数据
     *
     * @param prefix 搜索的前缀
     * @param keyword 搜索的关键字
     * @param start 开始位置
     * @param size 搜索的大小
     * @param sortType 是否按顺序排序
     * @return 返回匹配前缀和关键字的数据列表
     */
    @SuppressWarnings("unchecked")
    @Override
    public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
        // 构建用于搜索的键字符串
        String keyStr = prefix + "*" + keyword + "*";
        // 使用CAFFEINE缓存进行查找，如果缓存中没有则从Redis中获取
        return (List<String>) CAFFEINE.get(keyStr, k -> {
            // 根据键字符串在Redis中搜索所有匹配的键
            Collection<String> keys = RedisUtils.keys(keyStr);
            // 将搜索到的键集合转换为列表
            List<String> list = new ArrayList<>(keys);
            // 返回经过分页和排序处理后的列表
            return SaFoxUtil.searchList(list, start, size, sortType);
        });
    }
}
